home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / perl5 / Mail / Cap.pod < prev    next >
Text File  |  2008-07-29  |  4KB  |  201 lines
  1. =head1 NAME
  2.  
  3. Mail::Cap - Parse mailcap files
  4.  
  5. =head1 INHERITANCE
  6.  
  7. =head1 SYNOPSIS
  8.  
  9.  my $mc = new Mail::Cap;
  10.  $desc = $mc->description('image/gif');
  11.  
  12.  print "GIF desc: $desc\n";
  13.  $cmd = $mc->viewCmd('text/plain; charset=iso-8859-1', 'file.txt');
  14.  
  15. =head1 DESCRIPTION
  16.  
  17. Parse mailcap files as specified in "RFC 1524 --A User Agent
  18. Configuration Mechanism For Multimedia Mail Format Information>.  In
  19. the description below C<$type> refers to the MIME type as specified in
  20. the C<Content-Type> header of mail or HTTP messages.  Examples of
  21. types are:
  22.  
  23.   image/gif
  24.   text/html
  25.   text/plain; charset=iso-8859-1
  26.  
  27. You could also take a look at the File::MimeInfo distribution, which
  28. are accessing tables which are used by many applications on a system,
  29. and therefore have succeeded the mail-cap specifications on modern
  30. (UNIX) systems.
  31.  
  32. =head1 METHODS
  33.  
  34. =head2 Constructors
  35.  
  36. Mail::Cap-E<gt>B<new>(OPTIONS)
  37.  
  38. =over 4
  39.  
  40. Create and initialize a new Mail::Cap object.  If you give it an
  41. argument it will try to parse the specified file.  Without any
  42. arguments it will search for the mailcap file using the standard
  43. mailcap path, or the MAILCAPS environment variable if it is defined.
  44.  
  45.  Option  --Default
  46.  filename  undef
  47.  take      'FIRST'
  48.  
  49. . filename => FILENAME
  50.  
  51. =over 4
  52.  
  53. Add the specified file to the list to standard locations.  This file
  54. is tried first.
  55.  
  56. =back
  57.  
  58. . take => 'ALL'|'FIRST'
  59.  
  60. =over 4
  61.  
  62. Include all mailcap files you can find.  By default, only the first
  63. file is parsed, however the RFC tells us to include ALL.  To maintain
  64. backwards compatibility, the default only takes the FIRST.
  65.  
  66. =back
  67.  
  68. example: 
  69.  
  70.   $mcap = new Mail::Cap;
  71.   $mcap = new Mail::Cap "/mydir/mailcap";
  72.   $mcap = new Mail::Cap filename => "/mydir/mailcap";
  73.   $mcap = new Mail::Cap take => 'ALL';
  74.   $mcap = Mail::Cap->new(take => 'ALL');
  75.  
  76. =back
  77.  
  78. =head2 Run commands
  79.  
  80. These methods invoke a suitable progam presenting or manipulating the
  81. media object in the specified file.  They all return C<1> if a command
  82. was found, and C<0> otherwise.  You might test C<$?> for the outcome
  83. of the command.
  84.  
  85. $obj-E<gt>B<compose>(TYPE, FILE)
  86.  
  87. =over 4
  88.  
  89. =back
  90.  
  91. $obj-E<gt>B<edit>(TYPE, FILE)
  92.  
  93. =over 4
  94.  
  95. =back
  96.  
  97. $obj-E<gt>B<print>(TYPE, FILE)
  98.  
  99. =over 4
  100.  
  101. =back
  102.  
  103. $obj-E<gt>B<view>(TYPE, FILE)
  104.  
  105. =over 4
  106.  
  107. =back
  108.  
  109. =head2 Command creator
  110.  
  111. These methods return a string that is suitable for feeding to system()
  112. in order to invoke a suitable progam presenting or manipulating the
  113. media object in the specified file.  It will return C<undef> if no
  114. suitable specification exists.
  115.  
  116. $obj-E<gt>B<composeCmd>(TYPE, FILE)
  117.  
  118. =over 4
  119.  
  120. =back
  121.  
  122. $obj-E<gt>B<editCmd>(TYPE, FILE)
  123.  
  124. =over 4
  125.  
  126. =back
  127.  
  128. $obj-E<gt>B<printCmd>(TYPE, FILE)
  129.  
  130. =over 4
  131.  
  132. =back
  133.  
  134. $obj-E<gt>B<viewCmd>(TYPE, FILE)
  135.  
  136. =over 4
  137.  
  138. =back
  139.  
  140. =head2 Look-up definitions
  141.  
  142. Methods return the corresponding mailcap field for the type.
  143.  
  144. $obj-E<gt>B<description>(TYPE)
  145.  
  146. =over 4
  147.  
  148. =back
  149.  
  150. $obj-E<gt>B<field>(TYPE, FIELD)
  151.  
  152. =over 4
  153.  
  154. Returns the specified field for the type.  Returns undef if no
  155. specification exsists.
  156.  
  157. =back
  158.  
  159. $obj-E<gt>B<nametemplate>(TYPE)
  160.  
  161. =over 4
  162.  
  163. =back
  164.  
  165. $obj-E<gt>B<textualnewlines>(TYPE)
  166.  
  167. =over 4
  168.  
  169. =back
  170.  
  171. $obj-E<gt>B<x11_bitmap>(TYPE)
  172.  
  173. =over 4
  174.  
  175. =back
  176.  
  177. =head1 SEE ALSO
  178.  
  179. This module is part of the MailTools distribution,
  180. F<http://perl.overmeer.net/mailtools/>.
  181.  
  182. =head1 AUTHORS
  183.  
  184. The MailTools bundle was developed by Graham Barr.  Later, Mark
  185. Overmeer took over maintenance without commitment to further development.
  186.  
  187. Mail::Cap by Gisle Aas E<lt>aas@oslonett.noE<gt>.
  188. Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
  189. Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
  190. For other contributors see ChangeLog.
  191.  
  192. =head1 LICENSE
  193.  
  194. Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
  195. 2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.
  196.  
  197. This program is free software; you can redistribute it and/or modify it
  198. under the same terms as Perl itself.
  199. See F<http://www.perl.com/perl/misc/Artistic.html>
  200.  
  201.